HMGetBalloons

HMGetBalloons Is Balloon Help on or off?

#include <Balloons.h> Help Manager

returns TRUE = help is currently enabled

Returns: The HMGetBalloons function returns TRUE if help is currently

enabled and FALSE if help is currently not enabled. Because this

function does not load the Help Manager package into memory, it is

a very fast way to determine whether help is enabled.

Notes: If you only want to provide help balloons for the menus, alert boxes, and

dialog boxes of your application, you only need to create the resources

containing the de scriptive information. Using the Help Manager and its

sub sections give details on how to create these resources.

If help is not enabled, most Help Manager routines do nothing and return

the hmHelpDisabled result code.

The user turns Balloon Help assistance on by choosing Show Balloons

from the Help menu. You can use the HMGetBalloons function to

determine whether help is currently enabled. If you display your own help

balloons using the HMShowBalloon function, you should use the

HMGetBalloons function to determine whether help is enabled before

displaying a help balloon. If help is not enabled, you cannot display any help

balloons.

Referenced by (6):